Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add canonical URLs to legacy APM documentation #7310

Merged
merged 1 commit into from
Feb 16, 2022
Merged

docs: Add canonical URLs to legacy APM documentation #7310

merged 1 commit into from
Feb 16, 2022

Conversation

bmorelli25
Copy link
Member

Summary

In Elastic Stack version 7.16, the APM Guide was introduced. This guide is a combination of two previous documentation books, the APM Server Reference and the APM Overview. Forevermore, the 7.15 versions of the APM Server Reference and APM Overview will be marked as current 1 . This poses a problem: the Server Reference and Overview have strong SEO rankings, leading many google searches to these out-of-date docs, instead of to the real current APM Guide documentation.

This PR adds a canonical URL to pages in the 7.15 APM Server Reference and APM Overview that have similar or duplicate content in the current APM Guide. The hope is that these canonical references point searches to the new documentation, instead of the old docs.

1 This is a limitation of current build

Notes for myself if I have to do this again:

  • Find: \[\[(.+)\]\]
  • Replace: [id="$1",canonical-url=""]

Related

@bmorelli25 bmorelli25 added Team:Docs Label for the Observability docs team backport-skip Skip notification from the automated backport with mergify labels Feb 16, 2022
@bmorelli25 bmorelli25 requested review from gtback and a team February 16, 2022 19:51
@bmorelli25 bmorelli25 self-assigned this Feb 16, 2022
@bmorelli25 bmorelli25 mentioned this pull request Feb 16, 2022
Closed
22 tasks
@apmmachine
Copy link
Contributor

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-02-16T19:51:48.719+0000

  • Duration: 60 min 17 sec

Test stats 🧪

Test Results
Failed 0
Passed 4627
Skipped 16
Total 4643

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /hey-apm : Run the hey-apm benchmark.

  • /package : Generate and publish the docker images.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

gtback
gtback approved these changes Feb 16, 2022
View reviewed changes
Copy link
Member

@gtback gtback left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The diff looks like what I would expect.

@bmorelli25
Copy link
Member Author

Thanks! I checked the source on a few different pages as well, and everything looks good 🚀

Screen Shot 2022-02-16 at 1 30 01 PM

@bmorelli25 bmorelli25 merged commit 710d8fc into elastic:7.15 Feb 16, 2022
@bmorelli25 bmorelli25 deleted the 7.15-canonical branch February 16, 2022 21:32
@bmorelli25 bmorelli25 mentioned this pull request Apr 14, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gtback gtback gtback approved these changes

Assignees

@bmorelli25 bmorelli25

Labels
backport-skip Skip notification from the automated backport with mergify Team:Docs Label for the Observability docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bmorelli25 @apmmachine @gtback